home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr35 / km296i.zip / KMAIL.DOC < prev    next >
Text File  |  1993-06-20  |  34KB  |  791 lines
  1.                        Kmail Version  2.96
  2.                          Copyright 1990
  3.                                by
  4.                            Ken Krueger
  5.  
  6.                          Twin  Peaks  BBS
  7.  
  8.                   (303)-651-0225 - Hayes Ultra 144
  9.  
  10. Specifications:
  11. ---------------
  12.  
  13.   This version intended primarily for PCB 14.5.
  14.   Basic compatibility with PCB 15.0 (no extended msg base features)
  15.   Produces QWK compatible mail packets.
  16.   Supports up to 3000 conferences.
  17.   Reads CNAMES.@@@ to obtain conference information.
  18.   Reads TPA to obtain User information.
  19.   Updates USER file via USERS.SYS interface.
  20.   Resets "Mail Waiting" flags after a successful packet download.
  21.   Sets message 'has-been-read" flag after successful download.
  22.   Sets message-has-replies flag when appropriate.
  23.   Fully network compitable. Opens all files in share mode.
  24.   Locks message base during updating.
  25.   Message packets compatible with RNET.
  26.   Extended conference packets require RNET v1.07 or later.
  27.   Message packets tested with EZ-RDR v1.33 and SLMR v2.1.
  28.   Produces pre-scanned mail packets to save online time.
  29.   Limited file send services for Network hubs.
  30.   Sets the 'Have Mail Waiting' flags during message import.
  31.   BiModem protocol support including bi-directional mode.
  32.   HS/Link protocol support including bi-directional mode.
  33.   Does not currently support the fossil interface.
  34.  
  35. Evaluation
  36. ----------
  37.  
  38.   This evaluation  version of  Kmail is  provided so  that you  and your
  39. users may may decide  if this program meets  your needs.  Kmail  is 100%
  40. fully functional for the "sysop" in local mode.  The callers are limited
  41. to 10 messages per conference and to 50 total messages per packet.
  42.  
  43. In addition, you may call Twin Peaks and obtain a one time 60-day full
  44. function demo-key to help complete your evaluation. No fuss no muss,
  45. first time callers can obtain the demo-key.
  46.  
  47.  
  48. 60 Day Demo Key
  49. ---------------
  50.  
  51.   To obtain the 60 day demo key, just call Twin Peaks BBS (303-651-0225).
  52. Join conference (19) and open door 19 to download the demo key.
  53.  
  54.   In order for the Demo-Key to work, the name you use to register on
  55. Twin Peaks MUST exactly match the name in record #1 of your USERS file.
  56.            ----
  57.  
  58. Requirements
  59. ------------
  60.  
  61.    Dos 3.1 or greater.
  62.    PCBoard 14.5 or 14.5a
  63.    DSZ     version 05/25/89 or later.
  64.    PKZIP   v1.10 or higher.
  65.    HS/Link If you wish to support it.     (optional)
  66.  
  67. Note: Unregistered DSZ will only receive files to the current directory.
  68.       Unregistered DSZ can be made to work with Kmail, but modification
  69.       to the standard PCBRZ.BAT will be necessary.
  70.  
  71. Communications Ports
  72. --------------------
  73.  
  74.     Channel        I/O Port        Interrupt
  75.       COM1           $3F8            4
  76.       COM2           $2F8            3
  77.       COM3           $3E8            4
  78.       COM4           $2E8            3
  79.       COM5           undefined
  80.       COM6           undefined
  81.       COM7           $2E8            5
  82.       COM8           $3E8            5
  83.  
  84.  
  85. Support for non-standard COM port configurations is provided by
  86. using DOS Set statements as shown below:
  87.  
  88.      SET COMBASE=nnnn   ;port base I/O address.
  89.      SET COMIRQ=n       ;port IRQ setting
  90.  
  91.            NOTE:  nnnn above is expressed as a decimal number!
  92.  
  93.  
  94. Installation for Single Node
  95. ----------------------------
  96.  
  97.       (Refer to NETWORK.DOC file for Multi-Node Installation)
  98.  
  99.    1. Create a KMAIL sub-directory to hold the Kmail distribution files.
  100.       Place all files in the archive into this directory.
  101.  
  102.    2. Create a work sub-directory such as C:\KWORK for Kmail to use.
  103.       ***CAUTION***  ***CAUTION***     All files are erased in this
  104.       directory during the mail packet creation process. DO NOT use an
  105.       existing directory that has good stuff in it!  Multi-node systems
  106.       must have a unique work area for each node.
  107.  
  108.    3. Customize the KMAIL.CFG file. Ample comments are in the sample.
  109.       This is where you really customize the overall operation.
  110.       Parms 1-4 are passed along to the mail readers for their use.
  111.       While not critical, you should keep to the general outline in
  112.       the sample and customize them for your system.
  113.  
  114.  ==>  PARM 5: This one is important! This parm specifies the name of
  115.       the QWK mail packet that Kmail will create. While the name can be
  116.       anything, it would be best to have a name that is associated
  117.       with your BBS system name. (Do not specify a .extension here).
  118.  
  119.       The rest of the parms are optional. Among them are options to
  120.       control the number of messages based on connect speed, and
  121.       protocol transfer options. The default values are in the sample.
  122.  
  123.       DSZ is used as the main protocol and is activated via a call
  124.       to a BAT file which you may define in the KMAIL.CFG file. This
  125.       allows you to totally customize the DSZ parms to suit your
  126.       system. I just let it default to the standard PCBxx.BAT files
  127.       that I have setup for PCBoard. Be sure to include the BAT files
  128.       location in your DOS path! Kmail passes parms %1-%5 to the
  129.       BAT files just the same as PCBoard.
  130.  
  131.  
  132.       When a caller requests ╔════════════════════════════════════════╗
  133.       an external protocol,  ║       External Protocol Parameters     ║
  134.       PCBoard passes several ╠═════════╦══════════════════════════════╣
  135.       parameters to the      ║Parameter║         n9scription          ║
  136.       protocol batch file.   ╠═════════╬══════════════════════════════╣
  137.       These parameters are   ║   %1    ║COM Port Number.              ║
  138.       listed to the right.   ╟─────────╫──────────────────────────────╢
  139.                              ║   %2    ║PC to Modem Speed (DTE rate)  ║
  140.                              ╟─────────╫──────────────────────────────╢
  141.                              ║   %3    ║Filename to transfer.         ║
  142.                              ╟─────────╫──────────────────────────────╢
  143.                            * ║   %4    ║Connect Speed shown by PCBoard║
  144.                              ╟─────────╫──────────────────────────────╢
  145.                              ║   %5    ║Carrier Speed.                ║
  146.                              ╟─────────╫──────────────────────────────╢
  147.                              ║   %6    ║Upload Dir Path for BiModem   ║
  148.                              ║         ║and HS/Link type protocols.   ║
  149.                              ╚═════════╩══════════════════════════════╝
  150.  
  151.       * The %4 field is not easily determined within Kmail, therefore
  152.         upon exit to the protocol BAT files, Kmail adjusts the %4
  153.         field to the same value as %5.
  154.  
  155.       I have found the following works well with my Hayes 9600 v.42.
  156.  
  157.         PCBSZ.BAT
  158.               dsz ha bo est 0 %5 pB4096 sz -m %3
  159.  
  160.         PCBRZ.BAT
  161.               dsz ha slow est 0 %5 pB4096 z pr1 rz -m -p %3
  162.  
  163.  
  164.    4. Customize the KMAIL.CNF if necessary. This is a 2 or 3 line file.
  165.       The 1st line defines the interface routine that Kmail should
  166.       use, and the 2nd line defines the location of a work directory.
  167.       The 3rd line is optional and is needed only if you plan to
  168.       pre-scan mail packets for your callers.
  169.  
  170.       Line #1 should specify either INTERRUPT or BIOS.
  171.  
  172.         INTERRUPT  - The preferred method, use this if possible.
  173.         BIOS       - Used in some multi-node environment when INTERRUPT
  174.                      fails to work properly.
  175.  
  176.       Line #2 is the path\name of a scratch work directory. If the
  177.       sub-directory does not exist, it will be created. The name may
  178.       be anything. I use the name KWORK on my system.
  179.  
  180.       Line #3 is optional. If the pre-zip function (explained later) is
  181.       used, this line points to the holding sub-directory. It may be
  182.       any name, but I recommend something like KHOLD. Multi-node
  183.       systems MUST share a common KHOLD sub-directory in order for
  184.       pre-zip packets to be located from any node.
  185.  
  186.  
  187.         Sample KMAIL.CNF
  188.  
  189.         INTERRUPT       Line 1
  190.         C:\KWORK        Line 2  <-- Must be unique for each node!
  191.         D:\KHOLD        Line 3  <-- This is where pre-scanned mail
  192.                                     packets are stored. A common
  193.                                     directory shared by ALL nodes.
  194.  
  195.   ********************************************************************
  196.   **  Warning   **  Warning  **  Warning  **  Warning  **  Warning  **
  197.   ********************************************************************
  198.   *                                                                  *
  199.   *   ALL FILES ARE ERASED IN THE KWORK DIRECTORY DURING PROCESSING. *
  200.   *   MAKE SURE THE AREA YOU SPECIFY IS A SCRATCH AREA!              *
  201.   *                                                                  *
  202.   ********************************************************************
  203.   **  Warning   **  Warning  **  Warning  **  Warning  **  Warning  **
  204.   ********************************************************************
  205.  
  206.  
  207.    5. Create the BAT file to run the Kmail door. Kmail requires two
  208.       parameters when it is called. The 1st parameter specifies the
  209.       name of the CONFIG file. The 2nd parameter specifies the
  210.       the drive and path to your PCBoard main directory where the
  211.       PCBOARD.DAT file is located.
  212.  
  213.  
  214.       Echo off
  215.       SET KMAIL=
  216.       CD\Kmail
  217.       KMAIL KMAIL.CNF C:\PCB
  218.       C:
  219.       CD\PCB
  220.       Board
  221.  
  222.  
  223.    6. Add an entry in your DOORS.LST files for Kmail. Indicate that
  224.       a USERS.SYS *SHOULD* be created and that a DOOR.SYS should not
  225.       be created when Kmail is executed.
  226.  
  227.    7. Using PCBSM, select "User Info File Maintenance" and create
  228.       a KMAIL Third Party Application entry with the following info.
  229.  
  230.       Version      :    30
  231.       Static Size  :    18
  232.       Dynamic Size :     1
  233.       Keyword      : KMAIL    <---- Watch this one! See notes below.
  234.  
  235.       NOTE: The keyword parameter above must match the name of the BAT
  236.             file that is used to open the Kmail door. So, if the name
  237.             of your BAT file is something else, change the keyword
  238.             parameter accordingly.
  239.  
  240.       NOTE: If you will be using the PreZip function, then the Keyword
  241.             *must* be KMAIL.     (PreZip is explained later).
  242.  
  243.    8. Kmail will use the DOS Environment variable "COMSPEC=" to locate
  244.       COMMAND.COM in order to execute the archive and communications
  245.       programs. The location of the archive and communication programs
  246.       must also be included in your DOS path.
  247.  
  248.    9. Network Qnet Status:
  249.  
  250.       If your system will be acting as a HUB for other systems, then
  251.       you will need to create a QNET.DAT file to control the Qnet status
  252.       of the downline systems. The QNET.DAT file is a plain ordinary
  253.       text file which contains the names of the downline sysops whom
  254.       you wish to grant Qnet status. One name per line starting in
  255.       column 1 and EXACTLY 1 space between the first and last name.
  256.       Mixed case is ok. The QNET.DAT file should be placed in the
  257.       Kmail sub-directory. Qnet status permits a user to upload mail
  258.       on behalf of another person. Without Qnet status, a user is limited
  259.       to uploading only their own personal mail.
  260.  
  261.       (* ----------------------------------------------------------- *)
  262.       (* The sequence of names should NEVER be changed and new names *)
  263.       (* must only be added to the end of the file. If you need to   *)
  264.       (* remove a person from the list, then just XXX their name out *)
  265.       (* leaving the XXX's as a placeholder.                         *)
  266.       (* ----------------------------------------------------------- *)
  267.  
  268.       NOTE: I apologize for the shoddyness of this procedure. I am
  269.             working on a PCBsm type utility to handle this function.
  270.             It is high on the priority list and expect to have something
  271.             around the middle of 1991.
  272.  
  273.       The letter 'Q' is displayed on the conference selection screen
  274.       beside each conference to indicate Qnet status.
  275.  
  276.       If you have one or more conferences that you do not want echoed
  277.       to downline systems, setting the conference echo-flag to NO will
  278.       disable Qnet status for that conference. Messages can still be
  279.       downloaded for offline reading via a RDR, but cannot be merged
  280.       into the system message base.
  281.  
  282.   10. PRE-ZIP'ed mail packets.
  283.  
  284.       This function allows you to scan and zip a mail packet for a
  285.       user so that it is ready for download when the user calls in.
  286.       This is an especially usefull function for LD callers.
  287.  
  288.       You will need to create a sub-directory to serve as a holding
  289.       area for the pre-zipped packets. The location of the holding
  290.       directory is specified in the Kmail.cnf file as shown in step
  291.       (5) above. Multi-node systems may share the same holding area.
  292.  
  293.       A PREZIP.DAT file must be created in the Kmail sub-directory
  294.       which lists each sysop's name and assigns a unique sequence
  295.       number to each name. The sequence numbers are used to match up
  296.       a pre-zip packet with the proper caller and are not associated
  297.       with any other function in Kmail. Pre-zip packets will be
  298.       stored in the KHOLD directory until downloaded by the caller.
  299.       The users "MSG Pointers" are also stored in the KHOLD directory
  300.       and are posted to the users record upon successful downloading
  301.       of the pre-zip packet.
  302.  
  303. Note: The following format must be *STRICTLY* adheared to. The
  304.       name begins in column #1 and must not exceed 25 characters.
  305.       A comma MUST separate the name and it's following sequence
  306.       number. All names must have a three digit sequence number
  307.       following the name, leading zeros REQUIRED!  Mixed case is
  308.       allowed in the name. No two users should have the same number!
  309.  
  310.    Sample: PREZIP.DAT
  311.  
  312.       George Washington,026
  313.       John Smith,015
  314.       Bob Jones,009
  315.  
  316.  
  317.       I would suggest a SET Kmail= in your door bat file to insure
  318.       that PREZIP is never active for an online caller.
  319.  
  320.       Prezip processing is activated via a Kmail=PREZIP DOS environment
  321.       variable. The following is suggested in your event.sys file.
  322.  
  323.       Basically, the process is to make a call to PCB145 to build a
  324.       USERS.SYS followed by a call to Kmail to create the packet.
  325.  
  326.       Important! The use of : and ; at the appropriate places in the
  327.                  PCB145 command line is critical!!!
  328.  
  329.          Ex:  PCB145 /USERSYS;JOHN;SMITH;PWRD:12345;TPA:KMAIL
  330.                                                         ^^^^^
  331.       Carefull, this parm must match the bat file name.   |
  332.       ____________________________________________________|
  333.  
  334.       EVENT.SYS
  335.       ...
  336.       ...
  337.       Set Kmail=PREZIP              <===== (note CAPS)
  338.       cd\pcb
  339.       PCB145 /USERSYS;JOHN;SMITH;PWRD:12345;TPA:KMAIL
  340.       cd\Kmail
  341.       Kmail KMAIL.CNF C:\PCB LOCAL
  342.       cd\pcb
  343.       PCB145 /USERSYS;JOE;DOAKS;PWRD:FOOBAR;TPA:KMAIL
  344.       cd\Kmail
  345.       Kmail KMAIL.CNF C:\PCB LOCAL
  346.       If Exist USERS.SYS Del USERS.SYS
  347.       Set Kmail=                 <===== Important!! I suggest you also
  348.       ...                               include this line in your Kmail
  349.       ...                               door BAT file(s).
  350.       event continues.....
  351.  
  352.  
  353.   11. The installation of Kmail is now complete and you are ready to
  354.       begin initial testing as soon as everything is backed up!!!
  355.  
  356.  
  357.   12. Insure that the locations of DSZ and PKZxxx programs are defined
  358.       in your DOS path. Kmail will be unable to locate them if they
  359.       are not in the Dos path!
  360.  
  361.  
  362.     **** NOTE WELL **** NOTE WELL **** NOTE WELL **** NOTE WELL ****
  363.     **** NOTE WELL **** NOTE WELL **** NOTE WELL **** NOTE WELL ****
  364.     **** NOTE WELL **** NOTE WELL **** NOTE WELL **** NOTE WELL ****
  365.  
  366.   Obviously a  mail door  must update  the USERS  file to  store message
  367. pointers.  Please make sure your USERS file is backed up before  running
  368. Kmail.  There has  been one report of  trashed message pointers.   I was
  369. unable to track down the cause of the problem and it has not re-occured.
  370.  
  371.   Do not fall  into the trap  of making an  automatic backup each  night
  372. during  your  event  if  you  are  simply overlaying the previous nights
  373. backup.  If  a problem did  occur and you  did not catch  it for several
  374. days, you wouldn't have a valid backup copy.  I suggest that you keep  a
  375. minimum of seven grandfather copies of  your USERS file and each one  of
  376. them should be unique.
  377.  
  378.  
  379. Conferences
  380. -----------
  381.  
  382.   Kmail obtains all conference  related information from the  CNAMES.@@@
  383. file including  such items  as MSG  base location,  required security to
  384. join, and bulletins path/location.
  385.  
  386.   If  a  user  does  not  have  the  required  security  level to join a
  387. conference,  the  conference  will  be  listed  as <closed> on the Kmail
  388. conference selection menu.
  389.  
  390.   If you need to  delete a conference for  any reason, just insure  that
  391. the conference  name is  blanked out  using PCBsetup  and Kmail will not
  392. attempt to  process it.   It  will show  up as  *Empty* on the selection
  393. menu. Remember to do a global delete of the registered and scan flags!
  394.  
  395.  
  396. Private (R/O) Messages
  397. ----------------------
  398.  
  399.   Kmail will validate the caller  security level and compare it  against
  400. the appropriate values specified in  PCBsetup to determine if access  to
  401. to private messages including comments to sysop are allowed.  Conference
  402. Sysop status  is also  checked.   As with  PCBoard, you  may give global
  403. access to private messages by assigning a high enough security, or on  a
  404. conference by conference basis by assigning conference-sysop status.
  405.  
  406.  
  407. Qnet_Private=No/Yes    (Default=No)
  408. -------------------
  409.  
  410.   If you wish to allow  Network-Sysop's the ability to download  private
  411. mail without having to alter security levels, you can do this be putting
  412. the parameter Qnet_Private=Yes in the Kmail.CFG file.  However, R/O msgs
  413. that do not have  the "Echo" flag set,  will not be sent.   In addition,
  414. the same rule  applies to the  conference "Echo-flag" status.   In other
  415. words, for a R/O message to qualify using the Qnet_Private= option, both
  416. the conference Echo flag  AND the individual msg  Echo flag must be  set
  417. on.  Comments to Sysop are not included with this option.
  418.  
  419.  
  420. Ignore_Echo=No/Yes     (Default=No)
  421. ------------------
  422.  
  423.   This option only has meaning if you will be operating as a network hub
  424. with downline nodes receiving mail from  you.  When you enable a  caller
  425. for network-status, that status  only applies to conferences  defined as
  426. "echo" conferences  in pcbsetup.   Besides  "main", you  may have one or
  427. more local conferences on  your system.  If  you wish to allow  downline
  428. nodes  to  echo  your  local  conferences  including main, then set this
  429. option to Yes.
  430.  
  431.  
  432. Mail_Waiting=Yes/No    (Default=Yes)
  433.  
  434.   Use this option to control  whether Kmail will set the  "Mail Waiting"
  435. indicator during message importing.   With this option  enabled, callers
  436. will be notified  of waiting mail  in the various  conferences when they
  437. logon.  This  option will slowdown  the upload process  depending on how
  438. large of a users file you have.  This option causes Kmail to update your
  439. USERS and USERS.INF files, KEEP GOOD BACKUP'S of these files!!!
  440.  
  441.  
  442. Zip_Opt=xxx      (Internal Default - Zip_Opt=-a)
  443. -----------
  444.  
  445.   If for some reason you  need/want Kmail to use unique  Zip parameters,
  446. you may specify them using this option.
  447.  
  448.  
  449. UnZip_Opt=xxx      (Internal Default - UnZip_Opt=-e)
  450. -------------
  451.  
  452.   If for some reason you need/want Kmail to use unique UnZip parameters,
  453. you may specify them using this option.
  454.  
  455.  
  456. Qwk_Dir=path       (Default=None)
  457. Rep_Dir=path       (Default=None)
  458. ------------
  459.  
  460.   If you plan to use Kmail in local mode to capture mail to use with  an
  461. offline RDR, use these parameters  to specify the locations where  Kmail
  462. should place the QWK packet and  where to retrieve the REP file.   These
  463. options are  only for  the convenience  of the  Sysop when  operating in
  464. local mode.   A  DOS copy  command is  issued to  copy the .QWK and .REP
  465. files to/from these directories.
  466.  
  467.  
  468. Scan_Upld_Only=Yes/No   (Default=Yes)
  469. ---------------------
  470.  
  471.   This  option  controls  whether  just  the  upload  directory  or  ALL
  472. directories are scanned when the caller  selects the new file scan.   If
  473. you keep new files in the upload directories for several days/weeks then
  474. setting this option to  YES would be the  best choice.  However,  if you
  475. move new files out of the upload area rather quickly or perhaps have the
  476. "make all uploads private" switch enabled in PCB, then you will need  to
  477. specify NO for this option to prevent callers from missing new files.
  478.  
  479.   The scanning of new  files is limited to  the conference in which  the
  480. door was opened.  Private upload directories are NEVER scanned.
  481.  
  482.  
  483. Tag=
  484. ----
  485.  
  486.   KMail will append a  tag line to messages uploaded via the KMail door.
  487. You may customize the tag information to refelect your bbs info by using
  488. a TAG= parm in the CFG file. Example: Tag=Home of Super BBS
  489.  
  490. The tag information may be up to 60 characters long.
  491.  
  492.  
  493. Disable_Tag=Yes/No      (Default=No)
  494. ------------------
  495.  
  496.   This option may be used to completely disable the adding of TAG lines
  497. to uploaded messages should the need arrise to do so. This option is
  498. ignored in non-registered versions.
  499.  
  500.  
  501. Force_Tag=Yes/No         (Default=No)
  502. ----------------
  503.  
  504.   The tag  information is  normally appended  only on  messages uploaded
  505. into an Echo conference.  Set this option to Yes if you wish to have tag
  506. lines appended to messages in non-echo conferences (including Main).
  507.  
  508.  
  509. Disable_Goodbye=Yes/No   (Default=No)
  510. ----------------------
  511.  
  512.   In the event that you have special processing requirements and  prefer
  513. that callers not logoff directly from KMail, this option is provided  to
  514. disable the (G) command.  When enabled, this option will cause KMail  to
  515. translate all forms of the (G) command into a Quit command.  Upon return
  516. to PCBoard a  PCBSTUFF.KBD file will  be created which  contains a (BYE)
  517. command to log the caller off.  Only systems that are configured to Drop
  518. to Dos after each caller would need this option enabled.
  519.  
  520.  
  521. Disable=nn               (Default=15)
  522. ----------
  523.  
  524.   Use this option  to disable KMail  downloads 'nn' minutes  before your
  525. scheduled system event.  This is used to prevent a user from starting  a
  526. large download and running past the event start time.  Values from  0-60
  527. are accepted here.
  528.  
  529.  
  530. HS/Link and BiModem
  531. -------------------
  532.  
  533.   HS/Link and BiModem are fully supported in bi-directional mode. Obtain
  534. the bulletin from Salt Air for details on installing BiModem. HS/Link is
  535. easily installed with the documentation that comes with it. The standard
  536. PCBxx batch files you setup for these protocols should work just fine
  537. with Kmail.
  538.  
  539.  
  540. KMail Help
  541. ----------
  542.  
  543.   Insure that the file "KMHELP" is placed in the \KMAIL directory.  This
  544. file provides the online help function while in the door.  The help file
  545. can be modified, if nessary, to suit unique environments, but I  suggest
  546. that you don't alter it too much.
  547.  
  548.  
  549. Multi-Lingual Text Files
  550. ------------------------
  551.  
  552.   There is  currently limited  support for  Multi-Lingual files although
  553. the  main  menu  is  not  currently  included.   The following files are
  554. supported.   Just customize  the files  as necessary  and add the proper
  555. language extension.  The files must reside in the KMail directory  along
  556. with the English versions.  Please note that the English versions do not
  557. have an extension.
  558.  
  559.      NEWUSER    (Displayed to first time users)
  560.      KMHELP     (The online help information)
  561.      PNTMSG     (Displayed when user uploads their .PNT
  562.                  file to reset their message pointers)
  563.  
  564.  
  565. SCRIPT0 File
  566. ------------
  567.  
  568.   KMail checks the location specified in PCBSetup for the SCRIPT0  file.
  569. If a SCRIPT0 file is found it  is sent in the mail packet.   The various
  570. rdr's will display the SCRIPT0 file at the end of the rdr session.
  571.  
  572.  
  573. NEWUSER File
  574. ------------
  575.  
  576.   Included in the archive is a  file called NEWUSER, which is a  replica
  577. of the opening display presented to a first time user.  If this new user
  578. screen is satisfactory, you need do nothing.  However, should you desire
  579. to create your own customized message, just edit the sample NEWUSER file
  580. and place it  in the Kmail  directory and Kmail  will display it  rather
  581. than the hard coded text within the program.
  582.  
  583.  
  584. KMAIL.KEY
  585. ---------
  586.  
  587.   This information applies to registered users of KMail that are running
  588. multi-node systems.   If  the BBS  name (as  specified in  PSCsetup) has
  589. different text for each  node, you will need  a KEY file for  each node.
  590. KMail will first check to see  if a KMAIL.KEY exists, and will  use that
  591. if one exists.  If a KMAIL.KEY is not found, then the node # is appended
  592. to the name  and another attempt  is made to  process the KEY  file.  In
  593. other words, Node 1 would look for KMAIL1.KEY and Node 2 would look  for
  594. KMAIL2.KEY and so on.  This approach  will allow you to have all of  the
  595. KEY files in a single directory if you choose to do so.  Of course,  you
  596. still could have a KMAIL.KEY in a unique directory for each node too.
  597.  
  598. NOTE: If at any time  it appears that  your KMAIL.KEY is not functioning
  599.       properly, enter the  character "&" at the  main Kmail  menu screen
  600.       and the  data from the  key will be  displayed  on the terminal to
  601.       assist in the diagnosis of the problem.
  602.  
  603.  
  604. SYSFILE.DAT
  605. -----------
  606.  
  607.   This data file is used to control the sending of data files to network
  608. sysops.  To activate this option, create a SYSFILE.DAT file in the KMail
  609. directory and specify the complete Drive:\Path\Name.ext of the files you
  610. wish to be automatically included within the QWK packet.  The file dates
  611. are checked and  only those with  dates more recent  than the last  file
  612. transmitted are sent.   You may  list up to  24 files, one  FileName per
  613. line starting in column one.  The files will be zipped into  SYSFILE.ZIP
  614. and included in the QWK packet as appropriate.
  615.  
  616.  
  617. Extended Services
  618. -----------------
  619.  
  620.   You can create up to 8 catagories of file services numbered (0-7) that
  621. a user  may subscribe  to.   Files within  the selected  service will be
  622. included in the QWK mail packet.  To implement this function you need to
  623. create a SERVICES.LST file in the KMail subdirectory.  The  SERVICES.LST
  624. file contains a description of each available service.  For each service
  625. create a matching  SERVICEx.DAT file where  x coorsponds to  the service
  626. number.  The SERVICEx.DAT file(s) contains the full drive:\path\name  of
  627. each file contained  in the service  catagory, samples are  shown below.
  628. The SERVICES.LST file is also used as the menu screen when the caller is
  629. selecting their desired services.
  630.  
  631.  
  632.      SERVICES.LST
  633.      ------------
  634.  
  635.      Network News         <== SERVICE0
  636.      BBS Help/Tips        <== SERVICE1
  637.      Conference Listing   <== SERVICE2
  638.  
  639.  
  640.      SERVICE0.DAT               SERVICE1.DAT
  641.      ------------               ------------
  642.      C:\FILES\NET.DOC           E:\SOMEDIR\BBS.HLP
  643.      C:\FILES\NETSTAT.TXT       D:\PCB\HELP\TIPS.TXT
  644.                                 G:\STUFF\MODEM.DOC
  645.  
  646.  
  647.   The above is intended  to show the amount  of flexibility you have  in
  648. creating the various  services.  You  probably will want  to be somewhat
  649. more organized than the example.
  650.  
  651.  
  652. OLDINDEX
  653. --------
  654.  
  655.   PCB 15.0 introduced a new message base index file with an extension of
  656. ".IDX".   Kmail has  been updated  to be  fully compatible  with the new
  657. index record  format and  no special  action is  required on  your part.
  658. However, if the /OLDINDEX is present in the DOS environment variable  or
  659. the "maintain old  NDX" switch is  enabled for a  given conference using
  660. PCBSetup,  then  Kmail  will  also  maintain  the  older  NDX records as
  661. required.
  662.  
  663.  
  664. Getting Started
  665. ---------------
  666.  
  667.   Finally it's time to run Kmail.   Just login to the BBS in the  normal
  668. way and open  Kmail door.   As a first  time user, you  will be asked to
  669. answer some  configuration questions  as will  each user  when they  try
  670. Kmail the first time.  A  special feature in Kmail will detect  when the
  671. "sysop" is in local mode and  will issue a prompt asking where  to place
  672. the resulting QWK mail  packet.  You should  respond with the drive  and
  673. path, but WITHOUT the  trailing back-slash after the  name.  Use of  the
  674.  
  675. NOTE: Use of  the Loc_Dir option described above prevents having to type
  676.       this information each time you use the door.
  677.  
  678.        c:\temp     \      All of these are valid ways to specify the
  679.        d:\rdr       >--   location of where to place the QWK  packet
  680.        a:          /      when running in local mode.
  681.  
  682.   Later on when you are ready to upload any replies created with one  of
  683. the offline readers, Kmail will ask  where to obtain the REP file.   Use
  684. the same format as above to specify the location.
  685.  
  686.  
  687. Errors
  688. ------
  689.  
  690.   Any errors detected by kmail  including those from 3rd party  programs
  691. such as PKZip  and DSZ are  logged into a  file called $door.err  in the
  692. Kmail sub-directory.  In addition,  many of the errors are  also written
  693. to the  caller log  file.   Error information  is also  displayed to the
  694. callers.
  695.  
  696.  
  697. Notes and Misc Info
  698. -------------------
  699.  
  700.   Kmail  sends  a  bbsid.PNT  file  in  each  mail packet.  The PNT file
  701. contains the last-read message pointer for each conference that the user
  702. has selected.  In the event of a problem, a user may upload the PNT file
  703. to restore the message pointers.   Just extract the KMAIL.PNT  file from
  704. the QWK packet and upload it to Kmail using the 'P' menu option.
  705.  
  706.   The user may select/un-select  conferences and reset message  pointers
  707. by using the  appropriate options in  EZ-RDR.  Review  the documentation
  708. associated  with  EZ-RDR  for  additional  information.   When resetting
  709. message pointers, Kmail will accept an absolute message # or a  negative
  710. number such  as -25  which means  set the  message pointer  equal to  25
  711. messages from the end of the message base.
  712.  
  713.   Not yet documented on the menu screen is the ability to stack commands
  714. for the  download process.   The  command 'D  Y' will  download the mail
  715. packet and return you to the menu screen, while 'D G' will download  and
  716. log you off.  A 10 second timer is provided to allow you to change  your
  717. mind.  By using  stacked commands, the user  can avoid the question  "Do
  718. you wish to receive this packet?"
  719.  
  720.   Recent changes to PCBoard allow for passing command line parms to door
  721. programs. Kmail now takes advantage of this feature. Assuming  Kmail was
  722. installed as door #3, the following commands would be valid.
  723.  
  724.          Open 3 d       (open the door & start download scan)
  725.          Open 3 d y     (open the door, scan mail, yes to download)
  726.          Open 3 d g     (open the door, scan mail, download & goodbye)
  727.         Kmail d y       (open the door, scan mail, yes to download)
  728.         Kmail d y g     (open the door, scan mail, download, goodbye).
  729.  
  730.  
  731.   The following SET commands may be used to adjust the operation
  732.   of Kmail as appropriate.
  733.  
  734. SET PRODEBUG=ON
  735.      Enables total session logging to the file DEBUG.OUT.  Use this to
  736.      record door activity for later review.
  737.  
  738. SET OVCRT=ON
  739.      This environment enables a special CRT update mode that works best
  740.      with TaskView or OmniView systems.
  741.  
  742. SET CAPFILE=filename
  743.      This setting controls the name of the file generated by the ALT-F
  744.      (file out) and SET PRODEBUG=ON functions.  The default file name of
  745.      DEBUGxx.OUT is changed to the specified name.
  746.  
  747. SET COMSPEC=C:\COMMAND.COM
  748.     This environment variable specifies the location and name of your
  749.     current COMMAND.COM and is required if the location of COMMAND.COM
  750.     is not in the current DOS Path.
  751.  
  752. SET PATH=C:\DOS;C:\UTIL;C:\...
  753.      The PATH environment variable is used to locate many of the programs
  754.      called up by KMail.  Please insure  that your  archive utilities and
  755.      protocol driver programs are present in a directory listed in your
  756.      PATH environment.
  757.  
  758. In The Works
  759. ------------
  760.  
  761. Utility to handle Qnet status and view/change user options.
  762.  
  763.  
  764. Acknowledgements
  765. ----------------
  766.  
  767. Special thanks to Bill Walsh, whose system I crashed many times during
  768. early beta testing, and to Jeff Freeman whose eagle eye caught many
  769. potential problems, and to Ken Flower for testing >256 conferences.
  770. And thanks to the many others who played a part in the beta testing
  771. development of Kmail.
  772.  
  773.  
  774. Registration
  775. ------------
  776.  
  777.   Please see the file REGISTER.TXT for registration information.
  778.  
  779.   After receipt of your registration, you  will need to call my BBS  and
  780. obtain a customized KEY file, which will enable any and all features not
  781. available  in  the  evaluation  copy  of  Kmail.    Currently,  the only
  782. limitation is the number of messages allowed per mail packet.
  783.  
  784.   After obtaining your customized KMAIL.KEY file, just place it in  your
  785. KMAIL sub-directory to activate all features.
  786.  
  787.  
  788.                                  Ken Krueger
  789.                                  Twin Peak's BBS
  790.                     303-651-0225 - Hayes Ultra 144 v.32bis / v.42bis
  791.